Support `.coveragerc.toml` for configuration #1952

OlenaYefymenko · 2025-04-15T23:38:00Z

This patch provides a new configuration — .coveragerc.toml . Considering that many projects have switched to toml configurations, this change offers a more flexible approach to manage coverage settings.

Resolves #1643

OlenaYefymenko · 2025-04-15T23:41:17Z

coverage/config.py

+        (".coveragerc.toml", True, False),
        ("setup.cfg", False, False),


Is the priority of the new config properly determined in the config_files_to_try function?

Looks good.

OlenaYefymenko · 2025-04-15T23:41:54Z

tests/test_config.py

+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    def test_toml_config_file(self, filename) -> None:
+        # A pyproject.toml and coveragerc.toml will be read into the configuration.
+        self.make_file(filename, """\


Is the parameterization implemented appropriately, similar to pyproject.toml?

OlenaYefymenko · 2025-04-15T23:43:02Z

tests/test_config.py

+    def test_coveragerc_toml_priority(self) -> None:
+        """Test that .coveragerc.toml has priority over pyproject.toml."""


Is testing priority only over pyproject.toml in the test_coveragerc_toml_priority test sufficient?

OlenaYefymenko · 2025-04-15T23:48:44Z

@nedbat,
I've opened PR with the improvements, but I have a few doubts about my implementation. I've added comments in the code. I'd really appreciate your feedback on whether this approach works well.
Thank you!

nedbat

One change needed.

nedbat · 2025-04-16T11:17:38Z

coverage/config.py

+        (".coveragerc.toml", True, False),
        ("setup.cfg", False, False),


Looks good.

nedbat · 2025-04-16T11:17:57Z

tests/test_config.py

+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    def test_toml_config_file(self, filename) -> None:
+        # A pyproject.toml and coveragerc.toml will be read into the configuration.
+        self.make_file(filename, """\


nedbat · 2025-04-16T11:18:37Z

tests/test_config.py

+    def test_coveragerc_toml_priority(self) -> None:
+        """Test that .coveragerc.toml has priority over pyproject.toml."""


nedbat · 2025-04-16T11:19:00Z

tests/test_config.py

            """)
        with mock.patch.object(coverage.tomlconfig, "has_tomllib", False):
-            msg = "Can't read 'pyproject.toml' without TOML support"
+            msg = "Can't read '{filename}' without TOML support"


Looks like tests are failing because this needs to be an f-string.

Thank you. I will fix this error in the next commits. I run tox with version 3.12 locally, and I didn't see this error.

nedbat · 2025-04-16T11:20:12Z

Thanks for doing this. There are some other changes needed. Let me know which you want to do, and which I should do:

Update the documentation
Add an entry to CHANGES.rst
Add your name to CONTRIBUTORS.txt

OlenaYefymenko · 2025-04-17T22:32:36Z

Thanks for doing this. There are some other changes needed. Let me know which you want to do, and which I should do:

Update the documentation

Add an entry to CHANGES.rst

Add your name to CONTRIBUTORS.txt

Yes, I will add the changes

tests/test_config.py

doc/config.rst

webknjaz

Plz revert all the formatting changes. I marked some, find the rest.

doc/config.rst

tests/test_config.py

webknjaz · 2025-09-01T23:12:47Z

CHANGES.rst

+.. _pull 1952: https://github.com/nedbat/coveragepy/pull/1952
+
+
+.. start-releases


Invalid conflict resolution?

webknjaz · 2025-09-01T23:13:25Z

doc/config.rst

            [html]
            directory = coverage_html_report
            """,
+


Stray edit?

webknjaz · 2025-09-01T23:15:10Z

tests/test_config.py

-            """\
+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    def test_toml_config_file(self, filename: str) -> None:
+        # A pyproject.toml and coveragerc.toml will be read into the configuration.


Suggested change

# A pyproject.toml and coveragerc.toml will be read into the configuration.

# A pyproject.toml and .coveragerc.toml will be read into the configuration.

webknjaz · 2025-09-01T23:16:04Z

tests/test_config.py

-    def test_toml_parse_errors(self, bad_config: str, msg: str) -> None:
+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    @pytest.mark.parametrize("bad_config, msg", [
+        ("[tool.coverage.run]\ntimid = \"maybe?\"\n", r"maybe[?]"),


A lot of reformatting?

webknjaz · 2025-09-01T23:16:28Z

tests/test_config.py

        assert cov.config.xml_output == "/Users/me/somewhere/xml.out"
        assert cov.config.exclude_list == ["~/data.file", "~joe/html_dir"]
-        assert cov.config.paths == {"mapping": ["/Users/me/src", "/Users/joe/source"]}
+        assert cov.config.paths == {'mapping': ['/Users/me/src', '/Users/joe/source']}


webknjaz · 2025-09-01T23:17:30Z

tests/test_config.py

-        self.make_file(
-            "pyproject.toml",
-            """\
+        self.make_file("pyproject.toml", """\


This adds .coveragerc.toml to the list of configuration files that coverage.py will automatically search for, with higher priority than pyproject.toml but lower than .coveragerc.

Converts existing pyproject.toml tests to be parametrized to also test .coveragerc.toml functionality, ensuring both TOML config formats work identically.

This test ensures that when both .coveragerc.toml and pyproject.toml are present, .coveragerc.toml takes precedence as intended.

…agerc.toml configuration file support

OlenaYefymenko · 2025-10-19T23:05:18Z

I'm in progress - some tests have failed, I'm going to fix them

doc/config.rst

webknjaz · 2025-10-20T00:24:23Z

tests/test_config.py

-        # A pyproject.toml file will be read into the configuration.
+    @pytest.mark.parametrize("filename", ["pyproject.toml", ".coveragerc.toml"])
+    def test_toml_config_file(self, filename) -> None:
+        # A pyproject.toml and .coveragerc.toml file will be read into the configuration.


Well, not both, just one of them, right?

CHANGES.rst

tests/test_config.py

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>

CHANGES.rst

doc/config.rst

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>

OlenaYefymenko commented Apr 15, 2025

View reviewed changes

nedbat changed the title ~~🌐 Support .coveragerc.toml for configuration~~ Support .coveragerc.toml for configuration Apr 16, 2025

nedbat requested changes Apr 16, 2025

View reviewed changes

webknjaz reviewed Apr 18, 2025

View reviewed changes

tests/test_config.py Outdated Show resolved Hide resolved

tests/test_config.py Outdated Show resolved Hide resolved

Elenore23 approved these changes May 7, 2025

View reviewed changes

OlenaYefymenko marked this pull request as draft May 7, 2025 21:32

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 4018790 to 673b0c0 Compare June 15, 2025 23:16

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 673b0c0 to c584e0d Compare July 20, 2025 13:52

OlenaYefymenko commented Jul 20, 2025

View reviewed changes

doc/config.rst Outdated Show resolved Hide resolved

webknjaz reviewed Aug 18, 2025

View reviewed changes

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 6bee75f to 7565729 Compare August 18, 2025 22:17

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 7565729 to 2558209 Compare August 31, 2025 22:19

webknjaz reviewed Sep 1, 2025

View reviewed changes

webknjaz mentioned this pull request Sep 16, 2025

A bunch of CTracer selection (and other) tests fail on Fedora-based dev envs #2050

Open

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 2558209 to 05be667 Compare October 19, 2025 22:30

OlenaYefymenko added 5 commits October 20, 2025 01:37

Add .coveragerc.toml to configuration file search order

1dfdbe1

This adds .coveragerc.toml to the list of configuration files that coverage.py will automatically search for, with higher priority than pyproject.toml but lower than .coveragerc.

Parametrize TOML tests to include .coveragerc.toml

e89e195

Converts existing pyproject.toml tests to be parametrized to also test .coveragerc.toml functionality, ensuring both TOML config formats work identically.

Add test for .coveragerc.toml priority over pyproject.toml

4d67a35

This test ensures that when both .coveragerc.toml and pyproject.toml are present, .coveragerc.toml takes precedence as intended.

Update documentation, changelog, and contributors list for new .cover…

53e9aaa

…agerc.toml configuration file support

Update the documentation and fix code formatting in tests/test_config.py

0a508bf

OlenaYefymenko force-pushed the support-configuration-coverage-toml branch from 05be667 to 0a508bf Compare October 19, 2025 22:47